home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / programming / c / dicepj20.lha / diceproject / Project_EN.doc < prev    next >
Encoding:
Text File  |  1993-10-31  |  13.3 KB  |  535 lines
  1.  
  2.     Documentation Project Handler 2.0
  3.     =================================
  4.  
  5.        by Cedric Counotte
  6.  
  7.  
  8. 'Introduction'
  9.  
  10. 'Fast Install'
  11.  
  12. 'Details about installation'
  13.  
  14. 'How to register'
  15.  
  16. 'Copyright'
  17.  
  18. Hot News :
  19.     'Localization'
  20.     Inline 'help'.
  21.     Commodore® 'autodocs' usage.
  22.     Multi-task 'window' use.
  23.  
  24. Tools :
  25.     'Looking for' include files inside sources.
  26.  
  27. Application tour :
  28.     'Keyboard' use.
  29.     Keyboard 'specific' use.
  30.     How to operate 'windows'.
  31.     How to operate 'menu'.
  32.  
  33. 'Known bugs'
  34.  
  35. 'Thanks'
  36.  
  37. 'The author'
  38.  
  39.  
  40.     Introduction
  41.     ============
  42.  
  43. Project Handler is a front end application for DICE© from mattew dillon.
  44. It's similar to Borland Turbo C© on PC.
  45.  
  46. This application works only with OS2.0 +, and uses locale.library, amigaguide.library
  47. and OS 3.0 functions if possible.
  48.  
  49. It's 'localized', with a french and english catalogs.
  50. If you translate the catalog, send it to me, I'll include it with new release.
  51.  
  52. It's very easy to use it because of the 'help line' included.
  53. In order to use this item, you need either OS3.0 or, amigaguide.library which can be
  54. find on BBS or in Public Domain.
  55.  
  56. Project Handler is 'copyrighted' by Cedric Counotte living in France (Paris).
  57.  
  58. I had to translate the french doc myself, like you can read, it's not very good. Sorry.
  59. If someone want to make it better, just contact me.
  60.  
  61.  
  62.     Fast Install
  63.     ============
  64.  
  65. It's obvious, just copy the file Project or Project030 where you want, and run it.
  66.  
  67. Before you're able to work with, you need to change some options in
  68. 'Preferences' menu :
  69.     - 'General'
  70.     - 'Directory'
  71.     - Editor.
  72.  
  73. That's it, the application is ready to use!
  74.  
  75.  
  76.     Details about installation
  77.     ==========================
  78.  
  79. The important files ?
  80.  
  81.     - Project_??.guide had to be copied into Help:english or in the same directory
  82.     than the application.
  83.     +Change name as project.guide.
  84.  
  85.     - project.prefs can be found in ENV: and ENVARC: which represants initial preferences.
  86.     NB : Each project have his own 'preferences'.
  87.  
  88.  
  89. The important options ?
  90.  
  91.     - Compiler and Linker options, refer to dcc.doc.
  92.  
  93.     - 'Directory' options define where to find DICE library,
  94.     included files, and 'autodocs'.
  95.  
  96.     - Editor option from 'Preferences' menu in order to select
  97.     your favorite editor.
  98.  
  99. What's important in front of DICE ?
  100.  
  101.     - The bin directory must exist and contain das, dc1, dcc, dccpp and libmake.
  102.  
  103.     - The bin's parent directory MUST be define as DICE directory in
  104.     'Directory' window.
  105.  
  106.     - You can remove any assign for DICE inside startup-sequence.
  107.     The application do it for you.
  108.  
  109.  
  110.  
  111.     How to register
  112.     ===============
  113.  
  114. Easy again, send me a post card with your first and last name, age, sex,
  115. actual work, city and country.
  116.  
  117. If you owned an EMail, please send it too.
  118.  
  119. NB : All informations will remain private, and to your approbations.
  120.  
  121. All contributions will be wellcome and appreciate, it remains an options but give you
  122. a free update on disk for a minimum amount of 50 francs or 10 US$ (it's few).
  123.  
  124.  
  125.     Copyright
  126.     =========
  127.  
  128. Copyright (C) 1993 Cedric Counotte
  129.  
  130.     I hereby reject any liability or responsibility for these or any other
  131.     consequences from the use of Project Handler whatsoever.
  132.     The author can't be responsible for any dammage caused by
  133.     the use of this application.
  134.  
  135.     Neither the application, nor the source code can be use for commercial
  136.     purpose except Public Domain without the express autorization from the author.
  137.  
  138.  
  139.  
  140.     Localization
  141.     ============
  142.  
  143. The localization take some time, but here it is, with the catalog description,
  144. allowing you to translate it in any language.
  145.  
  146. This new options is active with OS2.1 and superior.
  147.  
  148.  
  149.     Help Line
  150.     =========
  151.  
  152. Only amigaguide.library owners will enjoy the online help.
  153.  
  154. The Help key provide, in any window, an access to project.guide, depending
  155. on which window is active.
  156.  
  157. The guide is completely independant, so you're able to use Project Handler
  158. while viewing the help guide.
  159.  
  160.  
  161.  
  162.     Commodore®'s Autodocs
  163.     =====================
  164.  
  165. Autodocs owners can translate the files in .guide, in order to view the
  166. .guide. For this purpose, you've just to specify guide's directory within
  167. the window 'Directory'.
  168.  
  169.  
  170.     Include files 'look for' function
  171.     =================================
  172.  
  173. When you've selected a C or assembler source file inside the
  174. 'source' window, you can recursivly look for
  175. included files (.h). Then, a list appear, so you can select one to edit/view.
  176.  
  177. In order to use the list with the keyboard, look the section about keyboard
  178. 'specific' use.
  179.  
  180.  
  181.     Project Handler with keyboard
  182.     =============================
  183.  
  184. The whole application can be use with the keyboard, standards shortcuts
  185. within the menu, an shortcuts from underlined words in windows.
  186.  
  187. Anyway, some things are 'specific' while using
  188. list view from 'Sources' ,'Messages' windows, and
  189. when 'looking for' include files. Also within
  190. 'Screen Options' window inside the list mode.
  191.  
  192.  
  193.     Keyboard specific use
  194.     =====================
  195.  
  196. Only lists view don't follow the rules from Commodore© about keyboard.
  197.  
  198. While there's only one list per window, arrows are used to move inside the list and,
  199. the enter key confirm the selection.
  200.  
  201. Also, any letter not used by buttons offer an access to the first name in the list
  202. starting with this letter.
  203.  
  204.  
  205.     Windows
  206.     =======
  207.  
  208. Project Handler open many windows, to allow you to configure and use the DICE front end. Every windows should be
  209. controlled with the mouse or the 'keyboard'.
  210.  
  211. Keyboard controll is 'specific' inside the following windows : Source, Messages and any list.
  212.  
  213. The application take care of every window at the same time. Thus, you can define options
  214. while entering the parameter linge.
  215.  
  216. For OS 3.0 owners, Source window's 'menu' is bended to every window.
  217.  
  218.     Every window's Title :
  219.  
  220.     'Sources'
  221.     'Messages'
  222.     'Parameter Line'
  223.     'Process'
  224.     'Main Options'
  225.     'Compiler Options'
  226.     'Linker Options'
  227.     'Directory Options'
  228.     'Screen Options'
  229.     'Palette Options'
  230.  
  231.  
  232.     Sources window
  233.     ==============
  234.  
  235. This window is the first you'll see when starting the gui, it contain all
  236. the files concerned while compiling and/or linking.
  237.  
  238. The filetypes actually recognised are :
  239.     - Assembler files        .a        (not tested)
  240.     - C source files        .c
  241.     - object files        .o
  242.     - DICE library        .lib
  243.  
  244. The list also show the following informations :
  245.     - Size in bytes of the C or assembler source file.
  246.     - Size in bytes of the generated object file.
  247.     - Comments attach or not to this files.
  248.  
  249. You'll see that the file name also show the path in case the file is not inside
  250. the source directory defined in the window 'Directory Options'.
  251.  
  252.  
  253. A double-click on this element brings your favorite editor you choose with the
  254. menu 'Preferences'.
  255.  
  256.  
  257. The 'Menu' controls the gui and the compilater. This menu is also
  258. attach to the window 'messages'.
  259.  
  260.  
  261.     Messages window
  262.     ===============
  263.  
  264. This window will show the errors while compiling or linking the project.
  265.  
  266. It may be controlled by 'keyboard' from the 'source' window.
  267.  
  268.  
  269.     Parameter line window
  270.     =====================
  271.  
  272. In this window you may specify the CLI parameter line to pass to your
  273. application.
  274. To edit the line, you should press the 'e' key to activate the
  275. string gadget.
  276. You can access this window via 'Executable' menu.
  277.  
  278. Be careful, because no output is specified when starting your application,
  279. but if your application have some printf, you may specify an output file
  280. inside the parameter line like this >'File name'.
  281.  
  282.  
  283.     Compile Window
  284.     ==============
  285.  
  286. This window appears when you select one of the following commands from the 'Executable' menu :
  287.     - Build All
  288.     - Compile
  289.     - Compile All
  290.  
  291. For more informations about these commands, see section 'Executable' menu.
  292.  
  293.  
  294.     General options window
  295.     ======================
  296.  
  297. In this window, you may choose project type, like :
  298.     - Amiga® executable.
  299.     - DICE library (.lib).
  300.     - EPROM file (not yet implemented!)
  301.  
  302. The two scroller enabled you to select which OS to use.
  303.  
  304.  
  305.     Compiler options window
  306.     =======================
  307.  
  308. Refer to DICE documentations.
  309.  
  310.  
  311.     Linker options window
  312.     =====================
  313.  
  314. Refer to DICE documentations.
  315.  
  316.  
  317.     Directories window
  318.     ==================
  319.  
  320. You must specify in this window directory path to the following
  321. type files :
  322.  
  323.     - Source :        Where the .c, .a, .o or .lib files should be found.
  324.  
  325.     - Destination : Where to create executable file.
  326.  
  327.     - Includes :    Path to include files (.h).
  328.  
  329.     - Library :     Path to library files (.lib).
  330.              If your project is a library, it will be created in this directory.
  331.  
  332.     - Objets :        Where to save object files (.o) generated from .c or .a sources.
  333.  
  334.     - DICE :        Path to DICE root. Directory 'bin' can be found inside it and
  335.              contain the files : dcc, dcpp, dc1, ...
  336.  
  337.     - Autodocs :    Path to Commodore®'s 'autodocs' in
  338.              guide format.
  339.  
  340.  
  341.  
  342.     Screen options window
  343.     =====================
  344.  
  345. From left to right and top to bottom, you'll see the following gadgets :
  346.  
  347.     - Screen Type : Enable you to choose between default public screen
  348.                   (Workbench) or a your own screen.
  349.  
  350.       You may type inside the string gadget the name of the public screen that
  351.       will be opened.
  352.  
  353.  
  354.     - Display ID  : You may select view mode inside this view list.
  355.  
  356.  
  357.     - Overscan      : Define the overscan to use for the screen.
  358.  
  359.  
  360.     - Width      : Define the exact width of your screen.
  361.               See also Autoscroll.
  362.  
  363.     - Height      : Same as above, but for height.
  364.  
  365.     - Palette      : You may choose default palette (SysFonts),
  366.               or make your own palette, for this
  367.               see 'Options Palette' window.
  368.  
  369.     - Autoscroll  : Switch autoscroll mode. To be use in conjonction
  370.               with width and height gadgets.
  371.  
  372.  
  373.     Palette window
  374.     ==============
  375.  
  376. It contain the following gadgets from left to right, top to bottom :
  377.  
  378.     - Pens :         Enable you to select the color of each intuition's pens.
  379.  
  380.     - Color Table :  Select the color to change with the fields
  381.                 Red|Green|Blue.
  382.  
  383.     - Red   :         These fields specify each components (RGB) of
  384.       Green         the current color.
  385.       Blue         It uses the TrueColor mode (0 à 255).
  386.  
  387.  
  388.     How to use Menus
  389.     ================
  390.  
  391. The use of the menu is classic.
  392.  
  393. Wen can notice however, than with the OS3.0 and up, the same menu is
  394. attach to all windows.
  395.  
  396. The LendMenu order from 3.0 is used, but it discomforts the Magic Menu
  397. application, the attached menu take the old look.
  398.  
  399.     Menus description :
  400.     'Project'
  401.     'Objects'
  402.     'Executable'
  403.     'Preferences'
  404.  
  405.  
  406.     Project Menu
  407.     ============
  408.  
  409. In this menu, you can find the following function :
  410.  
  411.     - New :       Create a new project.
  412.  
  413.     - Open :       Open an existing project.
  414.  
  415.     - Save :       Save the project in progress, launch the next function
  416.             when the project is unnamed.
  417.  
  418.     - Save as :    Show a file requester which permit to define the name
  419.             of the project and save it.
  420.  
  421.     - Iconify :    Not available for the moment (crash).
  422.  
  423.     - About... :   Open a requester which contain some information about
  424.             the application.
  425.  
  426.     - Help... :    With the library amigaguide, open this document and show
  427.             the part affected by the current window.
  428.  
  429.     - Quit :       Terminate the application.
  430.  
  431.  
  432.  
  433.     Object Menu
  434.     ===========
  435.  
  436.     - Edit :        Launch your favorite editor with the file name
  437.              selected as parameter.
  438.  
  439.     - Include files :    Show all the files included in the selected file.
  440.              You may edit one of them.
  441.  
  442.     - Comments :    Comments control.
  443.  
  444.     - Edit :    Add or create a new comment attach to the selected file.
  445.  
  446.     - Delete :    Delete a comment.
  447.  
  448.     - Add :        Add a new file to the actual list.
  449.  
  450.     - Remove :        Delete the selected file from the list.
  451.  
  452.     - Edit extern :    Edit an external file.
  453.  
  454.     - Open Autodocs :    Open an AutoDocs files from Commodore.
  455.              Need the amigaguide library.
  456.  
  457.  
  458.     Executable Menu
  459.     ===============
  460.  
  461.     - Make final object :   Generate the whole project.
  462.                  In the case of an executable, compile and link.
  463.                  Int the other case (library), compile et make the .lib file.
  464.  
  465.     - Compile :         Compile the files (check dependencies).
  466.  
  467.     - Compile all :        Compile all the files (do not check dependencies).
  468.  
  469.     - Launch :            Launch the project.
  470.  
  471.     - From CLI :        Launch from CLI.
  472.  
  473.     - Parameter Line :  Define the parameters line.
  474.  
  475.     - Information :        Show some information about your project.
  476.  
  477.  
  478.  
  479.     Preferences Menu
  480.     ================
  481.  
  482.     - Main options :     Show 'main options' window.
  483.  
  484.     - Compiler :     Define 'compiler' options.
  485.  
  486.     - Linker :         Define 'linker' options.
  487.  
  488.     - Directories :     Define 'directory' paths.
  489.  
  490.     - Editor :         Define your favorite editor.
  491.  
  492.     - Screen :         Define 'screen options'.
  493.  
  494.     - Close Workbench :  Close the workbench.
  495.  
  496.     - Open Workbench :     Reopen the workbench.
  497.  
  498.     - Save preferences : Save the actual preferences in the default prefs.
  499.  
  500.  
  501.     Known Bugs
  502.     ==========
  503.  
  504. - It's not possible to have directory with space for Objects directory.
  505.     It's not Project handler bugs but DICE own.
  506.  
  507. - The iconify menu item crash the application all the time ! ?
  508.     If you want to see what's involved in it, look the file main.c at
  509.     the line ProjectIcon.
  510.  
  511.  
  512.  
  513.     Thanks
  514.     ======
  515.  
  516. For beta release test : Olivier Bompuis (France).
  517.  
  518. For GadToolsBox : Jan van den Baard (Allemagne).
  519.  
  520.  
  521.     How to contact the author
  522.     =========================
  523.  
  524. You can contact me by mail :
  525.  
  526.     M Cedric Counotte
  527.     53 Rue Brillat Savarin
  528.     75013 PARIS - FRANCE
  529.  
  530. or by email :
  531.  
  532.     Fidonet : 2:320/106.0
  533.  
  534.  
  535.